Crate merkle_hash
source ·Expand description
Crate merkle_hash
makes it easy to find the hashes of all files and directories in a directory tree.
§Usage
To use this crate, add merkle_hash
as a dependency to your project’s Cargo.toml
:
[dependencies]
merkle_hash = "3.6"
§Features
- Finds the master hash of a directory tree with ease.
- Offers multiple hashing algorithms.
- Allows including names in the hashing process.
- Uses a merkle tree algorithm to compute the hashes of directories.
- External iteration over the paths and hashes of files and directories.
§Limitations
- Currently only supports UTF-8 paths and will fail if a path is not UTF-8 encoded.
§Optional
sha
- Add this cargo feature to includeSHA-256
andSHA-512
as hashing algorithms.parallel
- Enabled by default, this feature makes the crate utilize all available threads.encode
- Enabled by default, this feature adds thebytes_to_hex
andto_hex_string
functions.retain
- Disabled by default, this feature duplicates the children paths of directories upon traversal.
§Example: Get the master hash of a directory tree:
use merkle_hash::{Algorithm, MerkleTree};
let tree = MerkleTree::builder("/path/to/directory")
.algorithm(Algorithm::Blake3)
.hash_names(false)
.build()?;
let master_hash = tree.root.item.hash;
§Example: Iterate over a directory tree, getting the hash of each file and directory:
use merkle_hash::{Encodable, MerkleTree};
let tree = MerkleTree::builder("/path/to/directory").build()?;
for item in tree {
println!("{}: {}", item.path.relative, item.hash.to_hex_string());
}
§Example: Collapse the tree into any linear collection:
use std::collections::BTreeSet;
use merkle_hash::{MerkleItem, MerkleTree};
let tree = MerkleTree::builder("/path/to/directory").build()?;
let btree_set: BTreeSet<MerkleItem> = tree.into_iter().collect();
Re-exports§
Structs§
- Holds the path, hash and children paths of a file or directory
- Represents a single node on the merkle tree
- Owned node iterator
- Node iterator
- An utility struct that contains an absolute path and a relative path
- Represents an indexed directory tree
- Utility builder pattern
Enums§
- Hashing algorithms to choose from
Traits§
- Utility trait for converting hashes to hex strings
Functions§
- Converts a hash to a hex string